home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
BBS Toolkit
/
BBS Toolkit.iso
/
doors_2
/
ubt101.zip
/
UBT-DOC.ZIP
/
UBTSYSOP.DOC
< prev
next >
Wrap
Text File
|
1992-04-05
|
154KB
|
3,185 lines
U - B O A T
Version 1.00 - Apr 03, 1992
SysOp Documentation
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page i
----------------------------------------------------------------------------
TABLE OF CONTENTS
1.0 Introduction. . . . . . . . . . . . . . . . . . . . . . . . . 1
2.0 System Requirements . . . . . . . . . . . . . . . . . . . . . 2
3.0 Version History . . . . . . . . . . . . . . . . . . . . . . . 3
4.0 Installation & Setup. . . . . . . . . . . . . . . . . . . . . 4
4.1 The Configurations File . . . . . . . . . . . . . . . . . 4
LANG: Default Language. . . . . . . . . . . . . . . . . 4
DOCS: Documentation File. . . . . . . . . . . . . . . . 5
BULL: Highest Rated Players Bulletin (B/W). . . . . . . 5
BULLC: Highest Rated Players Bulletin (Color). . . . . . 5
BULL2: High Game Scores Bulletin (B/W) . . . . . . . . . 6
BULLC2: High Game Scores Bulletin (Color) . . . . . . . . 6
ALIAS: Allow Alias Toggle. . . . . . . . . . . . . . . . 6
EDIT1: Editor User 1 . . . . . . . . . . . . . . . . . . 6
EDIT2: Editor User 2 . . . . . . . . . . . . . . . . . . 7
EDIT3: Editor User 3 . . . . . . . . . . . . . . . . . . 7
PASWD: Editor Password . . . . . . . . . . . . . . . . . 7
SNOOP: Snoop Toggle. . . . . . . . . . . . . . . . . . . 8
PROTO: External Protocol Name. . . . . . . . . . . . . . 8
BATCH: External Transfer Batch Filename . . . . . . . . 8
EXT1: Documentation Extention #1 (ASCII). . . . . . . . 9
EXT2: Documentation Extention #2 (ASCII Compressed) . . 9
EXT3: Documentation Extention #3 (PCL-4). . . . . . . . 9
EXT4: Documentation Extention #4 (PCL-4 Compressed) . . 10
PURGE: Old Player Purge. . . . . . . . . . . . . . . . . 10
RESETS: Automatic High Scores Reset . . . . . . . . . . . 10
RESETR: Automatic Player Ratings Reset. . . . . . . . . . 10
PAUSE: 24 Line Pause Sequence for Bulletins. . . . . . . 11
4.2 The Batch File. . . . . . . . . . . . . . . . . . . . . . 11
4.3 Node & Port Files . . . . . . . . . . . . . . . . . . . . 12
NODES.BBS - The Node ID File. . . . . . . . . . . . . . . 12
PORTS.BBS - The Port ID File. . . . . . . . . . . . . . . 12
4.4 BBS Support Files . . . . . . . . . . . . . . . . . . . . 13
RBBS Support Files. . . . . . . . . . . . . . . . . . . . 13
Quick BBS Support Files . . . . . . . . . . . . . . . . . 14
Wildcat Support Files . . . . . . . . . . . . . . . . . . 14
PC-Board Support Files. . . . . . . . . . . . . . . . . . 14
GAP Support Files . . . . . . . . . . . . . . . . . . . . 15
WWIV Support Files. . . . . . . . . . . . . . . . . . . . 15
Spitfire Support Files. . . . . . . . . . . . . . . . . . 15
G-Mon Support Files . . . . . . . . . . . . . . . . . . . 16
4.5 Timegen Utility . . . . . . . . . . . . . . . . . . . . . 17
SYSOP - SysOp Paging Hours. . . . . . . . . . . . . . . . 17
LEVEL - Security Level Definitions. . . . . . . . . . . . 17
DAYT - Daily Time Limits. . . . . . . . . . . . . . . . . 17
DAYG - Daily Game Entry Limits. . . . . . . . . . . . . . 18
WAIT - Wait Times Between Game Entries. . . . . . . . . . 18
TIME - Max Entry Time Definitions . . . . . . . . . . . . 18
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page ii
----------------------------------------------------------------------------
TABLE OF CONTENTS (cont)
5.0 Maintenance Options . . . . . . . . . . . . . . . . . . . . . 19
5.1 Automatic Maintenance . . . . . . . . . . . . . . . . . . 19
5.2 Old Player Purging. . . . . . . . . . . . . . . . . . . . 19
5.3 Resetting Player Ratings. . . . . . . . . . . . . . . . . 19
5.4 Resetting Game High Scores. . . . . . . . . . . . . . . . 20
5.5 Resetting Full Game . . . . . . . . . . . . . . . . . . . 20
5.6 Restarting the Game . . . . . . . . . . . . . . . . . . . 21
6.0 Editors . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
6.1 Player Editor. . . . . . . . . . . . . . . . . . . . . . 23
Selecting Players. . . . . . . . . . . . . . . . . . . . 23
Player Status. . . . . . . . . . . . . . . . . . . . . . 23
Active Game. . . . . . . . . . . . . . . . . . . . . . . 23
Player Login . . . . . . . . . . . . . . . . . . . . . . 24
Player Alias . . . . . . . . . . . . . . . . . . . . . . 24
Player Password. . . . . . . . . . . . . . . . . . . . . 24
Player Ship. . . . . . . . . . . . . . . . . . . . . . . 24
Last Date Played . . . . . . . . . . . . . . . . . . . . 25
Total Time Played. . . . . . . . . . . . . . . . . . . . 25
Total Game Entries . . . . . . . . . . . . . . . . . . . 25
Language Setting . . . . . . . . . . . . . . . . . . . . 25
Graphics Setting . . . . . . . . . . . . . . . . . . . . 26
Message Delay Setting. . . . . . . . . . . . . . . . . . 26
Current Games Total. . . . . . . . . . . . . . . . . . . 26
Current Score Total. . . . . . . . . . . . . . . . . . . 26
Current Rating . . . . . . . . . . . . . . . . . . . . . 26
All Time Games Total . . . . . . . . . . . . . . . . . . 27
All Time Score Total . . . . . . . . . . . . . . . . . . 27
All Time High Rating . . . . . . . . . . . . . . . . . . 27
Edit Current High Scores . . . . . . . . . . . . . . . . 27
Edit All Time High Scores. . . . . . . . . . . . . . . . 27
Save Player. . . . . . . . . . . . . . . . . . . . . . . 28
Exit Player Editor . . . . . . . . . . . . . . . . . . . 28
6.2 Ratings Editor . . . . . . . . . . . . . . . . . . . . . 28
Editing Player Ratings . . . . . . . . . . . . . . . . . 28
Changing Last Reset Date . . . . . . . . . . . . . . . . 28
Saving Rating Information. . . . . . . . . . . . . . . . 29
Discarding Rating Information. . . . . . . . . . . . . . 29
6.3 High Scores Editor . . . . . . . . . . . . . . . . . . . 29
1st and 2nd Place Player Information . . . . . . . . . . 29
Players Name/Alias . . . . . . . . . . . . . . . . . . . 29
Players Ship Name. . . . . . . . . . . . . . . . . . . . 29
Players Score. . . . . . . . . . . . . . . . . . . . . . 29
Date Game Was Played . . . . . . . . . . . . . . . . . . 30
Changing Last Reset Date . . . . . . . . . . . . . . . . 30
Previous Game Information. . . . . . . . . . . . . . . . 30
Next Game Information. . . . . . . . . . . . . . . . . . 30
Saving High Scores . . . . . . . . . . . . . . . . . . . 30
Exiting High Scores Editor . . . . . . . . . . . . . . . 30
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page iii
----------------------------------------------------------------------------
TABLE OF CONTENTS (cont)
6.4 Games in Progress Editor . . . . . . . . . . . . . . . . 31
Changing Games . . . . . . . . . . . . . . . . . . . . . 31
Game Number. . . . . . . . . . . . . . . . . . . . . . . 31
Game Turn. . . . . . . . . . . . . . . . . . . . . . . . 31
Game Score . . . . . . . . . . . . . . . . . . . . . . . 31
Sub Bases. . . . . . . . . . . . . . . . . . . . . . . . 32
Destroyer Bases. . . . . . . . . . . . . . . . . . . . . 32
Transport Base Location. . . . . . . . . . . . . . . . . 32
Transport Ports. . . . . . . . . . . . . . . . . . . . . 32
Sub Status . . . . . . . . . . . . . . . . . . . . . . . 32
Sub Location . . . . . . . . . . . . . . . . . . . . . . 33
Destroyer Fuel . . . . . . . . . . . . . . . . . . . . . 33
Destroyer Depth Charges. . . . . . . . . . . . . . . . . 33
Destroyer Location . . . . . . . . . . . . . . . . . . . 33
Transport Launch Period. . . . . . . . . . . . . . . . . 33
Unlaunched Transports. . . . . . . . . . . . . . . . . . 33
Transports At Sea. . . . . . . . . . . . . . . . . . . . 33
Transport Missions Completed . . . . . . . . . . . . . . 34
Transport Completion Points. . . . . . . . . . . . . . . 34
Saving Game Information. . . . . . . . . . . . . . . . . 34
Exiting Game Editor. . . . . . . . . . . . . . . . . . . 34
6.5 Resetting High Scores. . . . . . . . . . . . . . . . . . 34
6.6 Resetting Player Ratings . . . . . . . . . . . . . . . . 35
6.7 Resetting Full Game. . . . . . . . . . . . . . . . . . . 35
6.8 Purging Old Users. . . . . . . . . . . . . . . . . . . . 35
6.9 Reviewing Program Error Log. . . . . . . . . . . . . . . 35
6.10 Exiting the Editor . . . . . . . . . . . . . . . . . . . 35
7.0 Creating Additional Game Scenarios. . . . . . . . . . . . . . 36
7.1 Maximum Scenario Support . . . . . . . . . . . . . . . . 36
7.2 Map File Format. . . . . . . . . . . . . . . . . . . . . 36
Seas . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Land . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Transport Base . . . . . . . . . . . . . . . . . . . . . 36
Transport Ports. . . . . . . . . . . . . . . . . . . . . 37
Destroyer Bases. . . . . . . . . . . . . . . . . . . . . 37
U-Boat Bases . . . . . . . . . . . . . . . . . . . . . . 37
Sea Lanes. . . . . . . . . . . . . . . . . . . . . . . . 37
8.0 Notes from the Author . . . . . . . . . . . . . . . . . . . . 38
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page iv
----------------------------------------------------------------------------
APPENDICES
A.0 Registration Information. . . . . . . . . . . . . . . . . . . A1
B.0 List of Files . . . . . . . . . . . . . . . . . . . . . . . . B1
B.1 Documentation Files . . . . . . . . . . . . . . . . . . . B1
B.2 Message Files . . . . . . . . . . . . . . . . . . . . . . B2
B.3 Program Files . . . . . . . . . . . . . . . . . . . . . . B3
B.4 Data Files. . . . . . . . . . . . . . . . . . . . . . . . B5
C.0 SysOp Function Keys . . . . . . . . . . . . . . . . . . . . . C1
D.0 Command Line Parameters . . . . . . . . . . . . . . . . . . . D1
E.0 Multi-Lingual Support . . . . . . . . . . . . . . . . . . . . E1
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page 1
----------------------------------------------------------------------------
1.0 Introduction
================
Welcome SysOp to U-Boat. U-Boat is a game of skill, strategy, and yes
even a bit of luck. It is designed to run as a "door" under most
popular BBS packages, but can just as easily be run stand-alone or
in a multi-user network environment.
If you are using the shareware/unregistered release, you, and your
users, will find several features disabled. This is done, of course,
as an incentive for you to register the software. We feel that enough
of the game is operational for you and your users to evaluate it. The
following is a list of differences between the shareware and registered
versions:
* No access to editors by the SysOp
* No ability to change or add game scenarios
* Unregistered version banner at login and
logout times.
* Occasional unregistered version messages
We feel that once you and your users have had time to "play around"
with the shareware version, you will want to register the software.
The registered version offers two major advantages. The first is the
the ability to add to the 5 basic game scenarios. This gives players
a greater variety of challenges and problems to solve. The second
is the SysOp access to the game editors. This is handy in being able
to delete players or visiting sysops who just wondered in once for
a look around. It may also allow you to help some players out of
a "jam", or (God forbid) get a player out of a position he is stuck in
due to a bug in the software.
For more information on registration please refer to appendix A and the
files REGISTER.TXT, DOORS.TXT, ORDER.TXT, and DISTRIB.TXT.
NOTICE: U-BOAT IS THE PROPERTY OF MYCROFT SYSTEMS, SAN JOSE, CA. YOU
MAY USE THE SHAREWARE VERSION OF THE GAME FOR A PERIOD OF NO MORE
THAN 45 DAYS. AFTER THAT EVALUATION PERIOD YOU MUST EITHER REGISTER
THE SOFTWARE OR REMOVE IT FROM YOUR SYSTEM. FAILURE TO DO SO IS A
VIOLATION OF THE SHAREWARE LICENSE AND IS IN EFFECT THEFT FROM THE
AUTHOR.
FOR THOSE SYSTEMS WHICH REGISTER THE PROGRAM, IT IS AGAINST YOUR
LICENSE AGREEMENT TO DISTRIBUTE THE REGISTRATION FILES IN ANY FORMAT
TO ANY OTHER PARTY WITHOUT THE EXPRESSED WRITTEN PERMISSION OF MYCROFT
SYSTEMS OR THE AUTHOR.
MYCROFT SYSTEMS ASSUMES NO LIABILITY FOR ANY DAMAGE TO YOUR EQUIPMENT
OR YOUR DATA IN ANY FORM DUE TO YOUR USE OF THIS PROGRAM. NO WARRANTY
EXPRESSED OR IMPLIED IS PROVIDED WITH THIS SOFTWARE PACKAGE AND YOUR
USE OF THIS SOFTWARE IS ENTIRELY AT YOUR OWN RISK.
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page 2
----------------------------------------------------------------------------
2.0 System Requirements
=======================
To run U-Boat, you will need and IBM or compatible PC computer, at
least 512K of RAM (game will run in much less), a BBS software package
compatible with the packages supported by U-Boat (or any other BBS
package combined with the use of a door conversion program), a modem,
and of course a phone line.
The following BBS packages are directly supported by U-Boat:
* Auntie
* GAP
* PC-Board
* Quick BBS
* RBBS 16.x and RBBS 17.x
* RBBS and G-Mon
* Remote Access
* Spitfire
* Tag
* Wildcat
* WWIV
As stated above, other software packages are either indirectly
supported, since they produce a door file compatible with one of the
above, or can be indirectly supported by using an external door
conversion program.
Support for the game and installation is available by calling or
writting to:
Mycroft Systems BBS
P.O. Box 7672
San Jose, CA. 95150
BBS: (408)927-0105
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page 3
----------------------------------------------------------------------------
3.0 Program History
===================
The following is a brief history of U-Boat along with version dates,
and software changes:
VERSION DATE DESCRIPTION
------- -------- -------------------------------------------------
B.00 02/15/92 Original version. Only distributed in the regis-
tered format, this version did not include the
game in progress editor, nor the formal SysOp do-
cumentation. The version suffered from several
obvious bugs.
B.01 03/15/92 This version was also only distributed in the
registered format. Several bugs were squshed.
By adding more sea lanes to the default game
scenario maps, the transport captains became a
tiny bit more intelligent (up to Moron 1st grade).
This version also repaired the bug dealing with
some text editors not being compatible with the
UBOAT.CFG file. The preliminary (unedited) ver-
sion of the SysOp documentation was also inclu-
ded. Default bulletin files are created by the
maintenance reset functions to avoid the error
messages saying that the files did not exist.
Lastly, the SysOp function key support code was
added.
1.00 04/03/92 This version will include the final versions of
the documentation. Also the Game in Progress
editor will be included. Lastly, the first
shareware version will become available. It is
also hoped that 1 or 2 language support sets will
be available with release 1.00.
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page 4
----------------------------------------------------------------------------
4.0 Installation & Setup
========================
U-Boat is supplied with it's own custom INSTALL.EXE program. It is
also fully compatible with the Standard Mycroft Command line. It is
recommended that you install the program using the install utility, but
in the event that you cannot locate a copy, or would prefer to install
it manually, the following section will explain in detail all the in-
formation required to setup and install the door.
The first thing to do is to create a directory that U-Boat will be
run out of. This could be something like UBOAT, U-BOAT, or anything
else you desire. Next create a subdirectory off of the U-Boat direc-
tory named DOCS. Copy or unzip all of the files in the ZIP file
UBT-DOC.ZIP into the DOCS subdirectory. Next, create a subdirectory
named MSGS and unzip all of the files in UBT-MSG.ZIP into the MSGS
directory. Then unzip all of the files in the ZIP file UBT-BIN.ZIP
into the main U-Boat directory. You will then need to edit/create
the files described below.
4.1 The Configurations File
---------------------------
The file UBOAT.CFG is the configuration file needed to control
the program. The file is a standard ASCII text file that may be
created or edited using any standard text editor. Do not use a
word processor to edit the program unless the word processor has
a non-document mode. The configuartion file is made up of con-
figuration commands. Each configuration command occupies a sin-
gle line and has a fixed format. Blank lines in the configura-
tion file are ignored. Comments may be imbedded in the configu-
ration file by starting the comment line with the ';' character
or by using the ';' to start a comment on a configuration line.
Configuration commands are optional and all of the values have a
default value. Configuration commands may be in any order within
the file. The configuration commands are described below:
LANG: Default Language
----------------------
The LANG command is used to specify the games default language.
The default language is used for all bulletin support, all
shared text, and at all points where the players selected
language is not yet known. The default language will also be
used for all errors written to the UBOAT.ERR file.
The LANG command has a single parameter. This parameter is the
language tag and corresponds to the language based files file
extention. The following language tags are defined, however
not all of the languages are yet "coded".
ENG - English code page 437 UKG - English code page 850
FRN - French code page 437 FRC - French code page 863
SPN - Spanish code page 437 SPS - Spanish code page 850
GRM - German code page 437 GMN - German code page 850
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page 5
----------------------------------------------------------------------------
ITL - Italian code page 437 ITN - Italian code page 850
PTG - Portugese code page 437 PTU - Portugese code page 860
Note that at this writting, only code page 437 (United States)
is supported. Others pay be added in the future.
Example: LANG: SPN
Default: LANG: ENG
DOCS: Documentation Dir
-----------------------
The DOCS command is used to specify where the documentation
files exist. This should be the full drive and pathname, but
relative paths are allowed. Please be careful when using
relative paths.
This command takes a single parameter. The parameter is the
complete drive and pathname to the documentation files
location. If you are using 2 or more of the documentation
extentions (see below), then make sure that all required files
are in the correct directory.
Example: DOCS: C:\UBOAT\DOCS
Default: DOCS: DOCS
BULL: Highest Rated Players Bulletin (B/W)
------------------------------------------
The BULL command is used to control where the Highest Rated
Players Bulletin (ASCII) will be created. This bulletin will
shows the users, the top five rated players. To qualify as
a rated player, the player must have completed all of the
first five scenarios at least once.
The BULL command has a single parameter which is the complete
drive, path, and filename of the bulletin to be created. Note
that relative pathnames are allowed are are relative to the
main U-Boat directory.
Example: BULL: C:\BBS\BULLETIN\BULLET10.TXT
Default: BULL: UBTBULL.BBS
BULLC: Highest Rated Players Bulletin (Color)
---------------------------------------------
The BULLC command is used to control where the Highest Rated
Players Bulletin (ANSI) will be created. This bulletin is the
same as the one described in the BULL command except that
ANSI color sequences & IBM extended graphics characters are
used.
Example: BULLC: C:\BBS\BULLETIN\BULLET11.TXT
Default: BULLC: UBTBULL.CLR
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page 6
----------------------------------------------------------------------------
BULL2: Game High Scores Bulletin (B/W)
--------------------------------------
The BULL2 command is used to control where the Game High
Scores Bulletin (ASCII) will be created. This bulletin will
show users, the top two scores acheived for each individual
scenario.
As a matter of courtesy to those players who are just learning
the game, the players may abandon a game in progress until
such time that they complete their first game.
The BULL2 command has a single parameter which is the com-
plete drive, path, and filename of the bulletin to be created.
Relative paths are permitted, and will be relative to the
main U-Boat directory.
Example: BULL2: C:\BBS\BULLETIN\BULLET12.TXT
Default: BULL2: UBTBULL2.BBS
BULLC2: Game High Scores Bulletin (Color)
-----------------------------------------
The BULLC2 command is used to control where the Game High
Scores Bulletin (ANSI) will be created. This bulletin is the
same bulletin as the BULL2 defined above, but ANSI color
sequences and IBM extended graphics characters are used.
Example: BULLC2: C:\BBS\BULLETIN\BULLET12.TXT
Default: BULLC2: UBTBULL2.CLR
ALIAS: Allow Alias Toggle
-------------------------
The ALIAS command is used to control whether a players real
name or his alias is displayed in any bulletins that he/she
has qualified for.
The ALIAS command has a single parameter. It should be set
to 'ON' to allow the alias to be displayed, or to 'OFF' to
force the players real name to be displayued.
Example: ALIAS OFF
Default: ALIAS ON
EDIT1: Editor User 1
--------------------
The EDIT1 command is used to specify a users login name who has
access to the game editors when running remotely. When the
door is run locally then whoever runs the program will have
automatic access to the editors (provided they know the editor
access password).
Please note that the editors may also be entered by using a
specific command line.
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page 7
----------------------------------------------------------------------------
The EDIT1 command has a single parameter. This parameter is
the user login name of the user who is being granted access to
the program editors. This parameter is NOT case sensative.
Example: EDIT1: MIKE BAYLEY
Default: EDIT1: SYSOP
EDIT2: Editor User 2
--------------------
The EDIT2 command is also used to specify a users login name
who has access to the game editors when running remotely. When
the door is run locally then whoever runs the program will have
automatic access to the editors.
The EDIT2 command has a single parameter. This parameter is
the user login name of the user who is being granted access to
the program editors.
Example: EDIT2: MIKE BAYLEY
Default: EDIT2:
EDIT3: Editor User 3
--------------------
The EDIT3 command is also used to specify a users login name
who has access to the game editors when running remotely. When
the door is run locally then whoever runs the program will have
automatic access to the editors.
The EDIT3 command has a single parameter. This parameter is
the user login name of the user who is being granted access to
the program editors.
Example: EDIT3: MIKE BAYLEY
Default: EDIT3:
PASWD: Editor Password
----------------------
The PASWD command is also used to specify a password that will
be required to gain access to the game editors when running
remotely. When the door is run locally then whoever runs the
program will not be required to enter a password.
Please note that to access the editors, that a seperate command
line format is used. Also note that the editors are not
available in the shareware copy of the program.
The PASWD command has a single parameter. This parameter is
the password required to gain access to the editors. The
password may be 0 or more words up to a total of 40 characters.
The password IS case sensative. If no password is specified,
then no password will be required to enter the editors when
running remotely. It is recommended as a matter of security
that a password be specified.
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page 8
----------------------------------------------------------------------------
Example: PASWD: U-Boat Password
Default: PASWD: U-BoatEdit
SNOOP: Snoop Toggle
-------------------
The SNOOP command is used to set the default setting of the
SysOp Snoop Toggle. If the toggle is set off, then no
information will be sent to the local display. If the toggle
is set to on, then the local display will show the same
information the user sees, plus a banner line at the bottom of
the screen showing the user name and current version number.
The snoop toggle may be changed at any point a user is online
and playing U-Boat by using the SysOp Keys (see the appendix
on SysOp Keys for more information).
It is recommended that the snoop toggle be set to off when
running in a multi-tasking environment such as Windows or
Desqview. By setting it to off, there will be no screen
display and it will then make the program run faster.
The SNOOP command has a single parameter. The parameter must
be set to either ON or OFF.
Example: SNOOP: OFF
Default: SNOOP: ON
PROTO: External Protocol Name
-----------------------------
The PROTO command is used to describe which external file
transfer protocol to use when the user selects the download
documentation feature. The protocol is defined in simple
english and does not necessarily reflect the program name used
to execute transfers. The value of this setting will be
displayed to the user in the download documentation menu.
The PROTO command has a single parameter. The parameter is
a single word used to describe the transfer protocol you
are supplying.
Example: PROTO: XModem
Default: PROTO: (No protocol downloads supported)
BATCH: External Transfer Batch Filename
---------------------------------------
The BATCH command is used to specify the .BAT file to be
executed whenever the user emplys the download documentation
feature.
The batch file is passed the comm port as parameter 1 (%1),
and the filename to transfer as parameter 2 (%2). The batch
file MUST also return to the U-Boat main directory before
returning back to the program.
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page 9
----------------------------------------------------------------------------
The BATCH command takes a single parameter. The parameter
is the complete drive, path, and filename (including the
extention .BAT) of the file to invoke when the players
selects the download documentation option.
Example: BATCH: UBTXFER.BAT
Default: BATCH: (No protocol downloads supported)
EXT1: Documentation Extention #1 (ASCII)
----------------------------------------
The EXT1 command takes a single parameter. The parameter
consists of 1 to 3 characters making up the filename exten-
tion to the standard ASCII version of the documentation.
When attempting to display or downlaod the standard docu-
mentation, the :DOCS command above defines the drive and
path of where to locate the file. The filename is always
'UBOAT' and this extetion is added to yield the complete
filename.
Example: EXT1: ASC
Default: EXT1: DOC
EXT2: Documentation Extention #2 (ASCII Compressed)
---------------------------------------------------
The EXT2 command takes a single parameter. The parameter
consists of 1 to 3 characters making up the filename exten-
tion to the compressed ASCII version of the documentation.
When attempting to downlaod the compressed documentation, the
:DOCS command above defines the drive and path of where to
locate the file. The filename is always 'UBOAT' and this
extetion is added to yield the complete filename.
Example: EXT2: ZOO
Default: EXT2: ZIP
EXT3: Documentation Extention #3 (PCL-4)
----------------------------------------
The EXT3 command takes a single parameter. The parameter
consists of 1 to 3 characters making up the filename exten-
tion to the HP+ (PCL-4) compatible version of the documen-
tation.
When attempting to downlaod the PCL-4 version of the docu-
mentation, the :DOCS command above defines the drive and
path of where to locate the file. The filename is always
'UBOAT-HP' and this extetion is added to yield the complete
filename.
Example: EXT3: HP
Default: EXT3: PCL
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page 10
----------------------------------------------------------------------------
EXT4: Documentation Extention #4 (PCL-4 Compressed)
---------------------------------------------------
The EXT4 command takes a single parameter. The parameter
consists of 1 to 3 characters making up the filename exten-
tion to the HP+ (PCL-4) compatible compressed version of the
documentation.
When attempting to downlaod the PCL-4 version of the docu-
mentation, the :DOCS command above defines the drive and
path of where to locate the file. The filename is always
'UBOAT-HP' and this extetion is added to yield the complete
filename.
Example: EXT4: LZH
Default: EXT4: ZIP
PURGE: Old User Ratings Purge
-----------------------------
The PURGE command is used to control the deletion of user
records from the game files. The command is provided a
single numeric parameter which is the number of days a user
can be out of the game without having his records deleted.
A value of 0 will disable the automatic user purge feature.
The single parameter provided can be any value between 0 and
32000.
Example: PURGE: 120
Default: PURGE: 90
RESETS: Automatic Game High Scores Reset
----------------------------------------
The RESETS command is used for automatic program restarting.
The command is provided a numeric value representing the
number of months between the restting of all game high sco-
re. A value of 0 will disable automatic use of this feature.
The single parameter provided can be any value between 0 and
32000.
Example: RESETS: 4
Default: RESETS: 0
RESETR: Automatic Game High Scores Reset
----------------------------------------
The RESETS command is used for automatic program restarting.
The command is provided a numeric value representing the
number of months between the restting of all game high sco-
re. A value of 0 will disable automatic use of this feature.
The single parameter provided can be any value between 0 and
32000.
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page 11
----------------------------------------------------------------------------
Example: RESETS: 4
Default: RESETS: 0
4.2 The Batch File
------------------
The batch file is used to execute the game from your BBS. The
batch file, depending on your BBS software, will either be a stand
alone batch file or simply a set of commands included in your BBS
master batch file. The batch file should change directory to the
U-Boat main directory, then execute the door using the Standard
Mycroft command line, then change directory back to the BBS, and
finally run the BBS if that is required by your BBS software.
Here is a sample batch file for Spitfire BBS:
ECHO OFF
ECHO ------------
ECHO U-BOAT
ECHO ------------
CD \DOORS\UBOAT
UBOAT 1 C:\SF SPITFIRE
CD \SF
The Standard Mycroft Command Line has the following format:
DOORNAME NODE_ID BBS_PATH BBS_TAG
where the DOORNAME is the name of the .EXE file to run the door,
the NODE_ID is the numeric ID number of the BBS node executing the
program (this will always be 1 on single node systems), BBS_PATH is
the full drive and pathname to your BBS directory, and BBS_TAG is
the tag identifying which BBS environment you are operating under.
The following is a list of currently valid BBS tags:
RBBS RBBS 16.x and RBBS 17.x
QBBS Quick BBS or any other BBS generating a
DORINFOx.DEF file.
WILDCAT Wildcat BBS or any other BBS generating a
CALLINFO.BBS file.
PCBOARD PC-Board 12.1 or any BBS generating a
compatible PCBOARD.SYS file
PCBOARD14 PC-Board 14.x or any BBS generating a
compatible PCBOARD.SYS file.
GAP GAP BBS or any other BBS generating a
compatible DOOR.SYS file.
WWIV WWIV BBS or any other BBS generating a
compatible CHAIN.TXT file.
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page 12
----------------------------------------------------------------------------
SPITFIRE Spitfire BBS or any other BBS generating a
compatible SFDOOR.DAT file.
SPITFIREK Spitfire BBS Main Menu command option.
SPITFIREM Spitfire BBS Message Menu command option.
SPITFIREF Spitfire BBS File Menu command option.
The BBS support file(s), the NODES.BBS file, and optionally the
PORTS.BBS file are expected to be in the directory pointed to by
the BBS_PATH parameter of the command line. See the BBS Support
files below for exact support filenames.
4.3 Node & Port Files
---------------------
The two files NODES.BBS and PORTS.BBS are support files used by all
Mycroft Doorware. Under normal circumstances, these files must be
located in your BBS directory. When running under G-Mon, these
files will need to be located in the same directory as the door
files.
NODES.BBS - Node ID File
------------------------
The NODES.BBS file is used to associate a serial communications
port with each of your BBS nodes. The file may be from 1 to n
lines long. It is a standard ASCII file containing the names
of the comm ports used by each node. Each line represents the
comm port associated with the node associated with that line
in the file (ie. line 1 is for node 1, line 2 is for node 2,
etc.).
The value COM0 is used to identify a local only node.
Otherwize legal values range from COM1 to COM8. If you are
using anything beyond COM4 you will need to describe the
hardware to the program using the facilities in PORTS.BBS. A
sample NODES.BBS file is shown below:
COM2
COM1
COM0
COM0
PORTS.BBS - Port ID File
------------------------
The PORTS.BBS file is used to describe and control the hardware
environment that the door program is to run under. This file
is optional and if not present the IBM defined default hardware
settings will be used along with an interrupt driven interface.
The PORTS.BBS file consists of 1 or more non-comment lines used
to define each hardware comm port. The format for each of
these lines is:
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page 13
----------------------------------------------------------------------------
PORT ADDR IRQ# INTE HAND PASS
where PORT is the port identifyer and may range from COM1 to
COM8; ADDR is the ports physical base address in hex; IRQ# is
the hardware IRQ number assigned to that port and may range
from IRQ0 to IRQ15; INTE is the interrupt flag and is set to
BIOS for BIOS or Fossil driver support, PORT for direct access,
and INTR for interrupt driven; HAND is the handshaking flag
which may be set to NONE for no handshaking, SOFT for XON/XOFF
handshaking, and BOTH for both types of handshaking; and
finally PASS is the passthru flag which is set to NO to prevent
IRQ passthru, and YES to allow IRQ passthru.
If not provided, then the following defaults are used:
; PORT ADDR IRQ# INTE HAND PASS
; ---------------------------------------
COM1 03F8 IRQ4 INTR HARD NO
COM2 02F8 IRQ3 INTR HARD NO
COM3 03E8 IRQ4 INTR HARD NO
COM4 02E8 IRQ3 INTR HARD NO
It is recommended that you use the default values unless you
have problems or are using COM5 through COM8. The passthru
should be set to YES if you have more than one device sharing
the IRQ in question.
4.4 BBS Support Files
---------------------
The following section describes the support files required by each
BBS type. The files should be in the BBS directory as pointed to
in the BBS_PATH parameter of the command line.
RBBS Support Files
------------------
The following files are required or expected under the RBBS
environment:
DORINFOx.DEF This file contains all of the users
settings such as graphics, parity, baud
rate, etc.
NODES.BBS This file contains a list of which DOS
device is used for each BBS node.
PORTS.BBS This file contains a list of the hardware
environment the program is executed in.
This file is optional and the IBM standard
values will be used if this file is not
found.
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page 14
----------------------------------------------------------------------------
Quick BBS Support Files
-----------------------
The following files are required or expected under the Quick
BBS environment:
DORINFOx.DEF This file contains all of the users
settings such as graphics, parity, baud
rate, etc.
NODES.BBS This file contains a list of which DOS
device is used for each BBS node.
PORTS.BBS This file contains a list of the hardware
environment the program is executed in.
This file is optional and the IBM standard
values will be used if this file is not
found.
Wildcat Support Files
---------------------
The following files are required or expected under the Wildcat
BBS environment:
CALLINFO.BBS This file contains all of the users
settings such as graphics, parity, baud
rate, etc.
NODES.BBS This file contains a list of which DOS
device is used for each BBS node.
PORTS.BBS This file contains a list of the hardware
environment the program is executed in.
This file is optional and the IBM standard
values will be used if this file is not
found.
PC-Board Support Files
----------------------
The following files are required or expected under the PC-Board
environment:
PCBOARD.SYS This file contains all of the users
settings such as graphics, parity, baud
rate, etc.
NODES.BBS This file contains a list of which DOS
device is used for each BBS node.
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page 15
----------------------------------------------------------------------------
PORTS.BBS This file contains a list of the hardware
environment the program is executed in.
This file is optional and the IBM standard
values will be used if this file is not
found.
GAP Support Files
-----------------
The following files are required or expected under the GAP BBS
environment:
DOOR.SYS This file contains all of the users
settings such as graphics, parity, baud
rate, etc.
NODES.BBS This file contains a list of which DOS
device is used for each BBS node.
PORTS.BBS This file contains a list of the hardware
environment the program is executed in.
This file is optional and the IBM standard
values will be used if this file is not
found.
WWIV Support Files
------------------
The following files are required or expected under the WWIV BBS
environment:
CHAIN.TXT This file contains all of the users
settings such as graphics, parity, baud
rate, etc.
NODES.BBS This file contains a list of which DOS
device is used for each BBS node.
PORTS.BBS This file contains a list of the hardware
environment the program is executed in.
This file is optional and the IBM standard
values will be used if this file is not
found.
Spitfire Support Files
----------------------
The following files are required or expected under the
Spitfire environment:
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page 16
----------------------------------------------------------------------------
SFDOORS.DAT These files contains all of the users
or settings such as graphics, parity, baud
SFMAIN.DAT rate, etc.
or
SFMESS.DAT
or
SFFILE.DAT
NODES.BBS This file contains a list of which DOS
device is used for each BBS node.
PORTS.BBS This file contains a list of the hardware
environment the program is executed in.
This file is optional and the IBM standard
values will be used if this file is not
found.
G-Mon Support Files
-------------------
G-Mon is the exception to the rule. The support files when
running under G-Mon must be in the directory with the door
files. The following files are required under G-Mon:
TIMEOFFx.DOR This file contains all the directory of the
monitor and the time controls fro the game
in progress.
NODES.BBS This file contains a list of which DOS
device is used for each BBS node.
The following files are required in the directory specified as
the monitor directory (in TIMEOFFx.DOR):
USERS.DOR This file contains all of the users
settings such as graphics, parity, baud
rate, etc, as well as info pertaining to
the node.
The following files will be created in the directory specified
as the monitor directory (in TIMEOFFx.DOR) at the time the
door exits:
POINTSx.DOR This file contains all of the amount of
time the user spent in Stellar Quest. It
also returns the amount of Door Monitor
points awarded for running the door (this
is always 0).
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page 17
----------------------------------------------------------------------------
4.5 Timegen Utility
-------------------
Timegen is an optional utility to allow you to add additional time
controls to the program. Timegen allows you to restrict use of the
program by security level, time of day, total program entries per
day, total time per day, and will also allow you to impose a
minimum time between program entries.
Timegen will compile a standard ASCII text file into a time control
file for use by the program. The command to execute Timegen is:
TIMEGEN INFILE OUTFILE
where INFILE is the ASCII text source file and OUTFILE is the time
control file for use by the door program.
The source file may not include blank lines nor any comment lines.
Each line may however end in a comment starting with a ';'
character. The source file must contain, in the specified order,
the following lines: SYSOP, LEVEL, DAYT, DAYG, WAIT, and 1 to 8
TIME lines. The format of each line is described below:
SYSOP - SysOp Paging Hours
--------------------------
The SYSOP command is used to specify the paging hours available
to users when in the program. The first parameter is the start
time and the second parameter is the stop time. Each parameter
is in 24 hour HHMM format and may range between 0000 and 2359.
If the start and stop times are identical then paging is
disabled.
Example: SYSOP 1000 2130
LEVEL - Security Level Definitions
----------------------------------
The LEVEL command is used to define security level groups for
use with the other Timegen functions. There must be 8 security
groups defined. Each entry defines the base of the security
group with the cap of the security group being 1 less than the
next entry on the line. Users with a security level less than
the first security group base will be denied access to the
program.
EXAMPLE: LEVEL 010 020 030 050 070 100 200 500
DAYT - Daily Time Limits
------------------------
The DAYT command defines the maximum daily time limit for each
of the corresponding security level groups. This command must
have 8 timelimits each associated to the corresponding security
group. A value of 0 indicates no time restrictions and any
other value is the daily limit expressed in minutes.
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page 18
----------------------------------------------------------------------------
Example: DAYT 030 045 060 060 060 090 090 000
DAYG - Daily Game Entry Limits
------------------------------
The DAYG command defines the maximum daily entry limit for each
of the corresponding security level groups. This command must
have 8 gamelimits each associated to the corresponding security
group. A value of 0 indicates no maximum game entries and any
other value is the daily limit expressed in number of entries.
Example: DAYG 002 005 005 010 010 010 010 000
WAIT - Wait Times Between Game Entries
--------------------------------------
The WAIT command defines the number of minutes users of each
of the corresponding security level groups must wait between
entries. 8 wait times, each associated to the corresponding
security group, must be specified in the command. A value of
0 indicates no wait, any other value is the daily wait time
expressed in minutes.
Example: WAIT 030 030 015 015 015 000 000 000
TIME - Max Entry Time Definitions
---------------------------------
The TIME command defines the maximum time limit per program
entry for each of the corresponding security level groups.
Each TIME command line (from 1 to 8) represents a period during
the day. The first parameter represents to start of the time
period. The period is expressed in 24 hour HHMM format and
runs from the time specified to 1 minute less than the next
entry. TIME command lines must be listed in time ascending
order. The last TIME command line is assumed to have an ending
time of midnight.
Following the time period base 8 time limits, each associated
to the corresponding security group, must be supplied. A value
of 0 indicates that access is denied during that time period,
and any other value is the entry limit expressed in minutes.
Example: TIME 0000 060 060 090 090 090 090 090 999
TIME 0630 030 030 045 045 045 045 045 999
TIME 1000 020 020 030 030 030 030 030 999
TIME 1630 000 000 000 000 030 030 030 999
TIME 2330 060 060 090 090 090 090 090 999
Note that when Timegen is used, the user receives the minimum
amount of time based on: 1) Time remaining on BBS, 2) Time
restrictions set by the program, 3) Time restrictions set by
Timegen.
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page 19
----------------------------------------------------------------------------
5.0 Maintenance Options
=======================
Maintenance NEED NOT be run everyday. Bulletins are automatically
updated, when needed, at the completion of each game. The maintenance
operations are primarily for deleteing old players and for restarting
the high score and high ratings races.
5.1 Automatic Maintenance
-------------------------
Automatic Maintenance is invoked using the following command line:
UBOAT MAINTENANCE
When maintenance is run, up to three things may occur depending
upon your settings in the configuration menu. These three include
the deletion of players who are inactive, the resetting of all
current player ratings, and the resetting of all the game high
scores. Each of these items is controlled through statements in
the configuration file. It is suggested that if any of these
options are active, that maintenance be run a minimum of once
each month.
5.2 Old Player Purging
----------------------
Purging old players is a maintenance function designed to limit
the amout of space used by U-Boats data files. It should be run
from time to time in order to remove users who are no longer
actively playing U-Boat. The amount of time a user may refrain
from playing the game before he is removed is controlled by the
configuration file command 'PURGE:'.
There are 3 ways in which players may be purged. The first is
through the Automatic Maintenance command line descrivbed above.
The second is to simply force a maintenance by typing the above
command from the DOS prompt while in the U-Boat directory. The
last is through the editor command 'Purge Old Users'.
Note that all of the above mentioned ways make use of the 'PURGE:'
configuration file command and will use it's setting. If it is
set to a value of '0', then user will never be purged.
5.3 Resetting Player Ratings
----------------------------
The resetting of player ratings will cause the master rating record
to be cleared, and all of each players 'current' rating figures
to be reset. Note this noes not effect a players 'all time'
rating information.
There are six ways that this function can be executed. The first
is through the Automatic Maintenance discribed above. The second
is to manually type the Automatic Maintenance command line from
the DOS prompt while in the U-Boat directory. Both of these
methods will check the configuration file command 'RESETR', which
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page 20
----------------------------------------------------------------------------
determines the number of months between each ratings reset.
The third and fourth methods are through the maintenance command
lines:
UBOAT RESETR
UBOAT RESET
The first of these will reset only the ratings, while the second
will also reset all of the game high scores. Unlike the first
two methods, these commands will have an immediate effect and
do NOT pay attention to the configuration file commands.
The last two methods are identical to the third and fourth
methods, except they are executed from the editor instead of
using the command line. This allows this function to be run
remotely if a remote user has editor access.
5.4 Resetting Game High Scores
------------------------------
The resetting of Game High Scores will cause the master high
score record for each game (1-25) to be cleared. It will also
case each player's CURRENT game high scores to be cleared. This
has no effect on the player's 'all time' high scores.
There are six ways that this function can be executed. The first
is through the Automatic Maintenance discribed above. The second
is to manually type the Automatic Maintenance command line from
the DOS prompt while in the U-Boat directory. Both of these
methods will check the configuration file command 'RESETS', which
determines the number of months between each high scores reset.
The third and fourth methods are through the maintenance command
lines:
UBOAT RESETS
UBOAT RESET
The first of these will reset only the game high scores, while
the second will also reset all of the game high scores. Unlike
the first two methods, these commands will have an immediate effect
and do NOT pay attention to the configuration file commands.
The last two methods are identical to the third and fourth
methods, except they are executed from the editor instead of
using the command line. This allows this function to be run
remotely if a remote user has editor access.
5.5 Resetting Full Game
-----------------------
The resetting of the full game is the combination of the above
two commands 'RESETR' and 'RESETS'. This command, if executed
using the MAINTENANCE command line function will only reset
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page 21
----------------------------------------------------------------------------
each of the items depending upon their configuration command
settings.
There are only two methods which guarantee a full game reset.
The first is through the DOS command line:
UBOAT RESET
The second is the equivalent function executed from inside the
game editors. Note that this function has no effect on players
being deleted from the game nor from having their 'all time'
high scores reset.
Note that all of the maintenance 'RESET?' functions will also
cause the bulletins to be updated if either the game high scores
or the high ratings are cleared.
5.6 Restarting the Game
-----------------------
If you should desire to completely reset the game, including
removing all players and games in progress, then delete all of
the .DAT files in the main U-Boat directory. This can be achieved
through the DOS command line:
DEL *.DAT
when executed from the main U-Boat directory. You must then
execute the DOS command line:
UBOAT RESET
which will cause the master ratings and game scores to be ini-
tialized and the bulletins to be cleared.
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page 22
----------------------------------------------------------------------------
NOTE: THESE CHAPTER ONLY APPLY TO THE REGISTERED VERSION OF U-BOAT!
6.0 Game Editors
================
The game editors serve a combination of needs. The major of these is
for ongoing test and debug of the software. Because of this, many of
the editors will allow you to modify almost all of the fields and
controls. Doing this is not recommended as it could change game
balance or even cause the game to crash due to invalid conditions.
Please be careful when using the editors.
A second and more useful use of the editors is to fine tune a new game
design. By "playing around" with the new game maps, the game designer
may balance the game between fairness and difficulty level.
A third use for the editors is to make small changes and repairs to
player and other game records when an error occurs and causes a
player to be unable to either enter the game or to play the game.
It is hoped this will not be required, but the feature is included
just in case.
There are four main editors plus the ability to execute maintenance
commands that are included in the package. The editors are: the
Player Editor, the Ratings Editor, The High Scores Editor, and the
Game in Progress Editor. Each of these is described below.
The editors can be invoked with either of two command lines. The first
format is for running the editor from the local console. The command
line used for this is:
UBOAT EDITOR
The second command line format is used to run the editors from a remote
terminal or computer. This format is almost identical to the command
line used to invoke the game, and it uses the same BBS tags and other
parameters. The command line used to run remotely is:
UBOAT NODE_ID BBS_PATH BBS_TAG EDITOR
where NODE_ID is the numeric ID number of the BBS node executing the
program (this will always be 1 on single node systems), BBS_PATH is
the full drive and pathname to your BBS directory, and BBS_TAG is the
tag identifying which BBS environment you are operating under. The
BBS tags are the same as those used to invoke the game.
In both of these modes, your user login will be compared to those in
the game configuration file to make sure there is a match. You will
also be required to enter the editor password before access to the
editors is granted.
For users who have editor access, they may also enter the editors
from the game's main menu be depressing the 'E' command. Once again,
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page 23
----------------------------------------------------------------------------
the user will be prompted for the editor access password. Note that
the editor password IS case sensative and MAY be more than a single
word.
You will find that some items displayed in the edit screens are just
that. They are display only. Allowing change of these would either
require extremely complex code or would have major possibilities of
corrupting the game. These fields will be identified by generating
a beep when an attempt to edit them is made.
6.1 Player Editor
-----------------
The Player Editor will allow you to examine and modify the
records in the player file. These pertain to the player's
personal information (such as login, password, alias, etc),
his timing functions (such as amoutn of time played during
the day, or number of game entries during the day), as well
as his game settings and scoring information.
Selecting Players
-----------------
The top of the Player Editor screen shows the current players
record number and the total number of player records. You
may jump from player record to player record by using the
PgUp and PgDn keys (with NumLock set of course). If you
attempt to change player records after modifying a record,
you will be prompted to make sure you wish to change records
AND IGNORE THE CHANGES to the player record.
Player Status
-------------
The Player Status represents the state of the current player
record. It will contain a '0' value if the record has been
deleted, or will contain the record number if the player is
still active.
As of this version, this field may not be changed. In a
later version, this may be changed.
This field may contain an integer value '0' or greater.
Active Game
-----------
The Active Game field shows whether or not the player is
currently in the midst of playing a game. A value of '0'
or 'None' means the player is not actively playing a sce-
nario. A positive integer indicates the 'Game in Progress'
record number of the scenario that he/she is playing.
This field may contain any integer 0 or larger. You must
be extremely careful when modifying this field. If you clear
it from an active game to 0, then you should also clear the
appropriate record in the 'Games in Progress' editor.
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page 24
----------------------------------------------------------------------------
It is completely unadvisable to change this value for 0
(or None) to a positive number. You will be doing one
of three things (which will all result in disaster).
First, you could be connecting it to a non-existing game
record in which case the player will end up locked out of
the game. Secondly you could be connecting to a deleted
game record in which case, the results are completely
unknown and could actually cause the code to 'lock up'.
Thirdly, you could be connecting to a game already in
progress that another player is playing, thus creating
problems for both players (again with unpredictable
results).
Player Login
------------
This field contains the players BBS login name. Changing
this field will have the effect of disconnecting him/or her
from all previous and any ongoing games and ratings. This
is not advisable with the exception of if you are going to
allow a user to change his BBS login and he still wants to
continue playing U-Boat where he/she left off.
This field may contain from 1 to 31 characters.
Player Alias
------------
This field contains the alias the player has chosen to use
in the game. This field will be used in bulding bulletins
if you have enabled the use of aliasses in the configuration
file. There is no danger in changing this field.
The field may be 1 to 31 characters in length.
Player Password
---------------
The player password field contains the players local game
access password. Changing this field will obviously lock
the player out of the game when the game is played locally.
Under normal circumstances, you will only modify this
field at the players request.
This field is 1 to 31 characters long. It IS case sensative
and may be more than one word. It is only used when the
player enter locally. If the player originally entered the
game through a BBS, then this field will have been set to
'Password'.
Player Ship
-----------
This field contains the the name the player chose for his
ship when he first entered the game. It is only used when
generating the bulletins. Normally, you will only change
this field at the players request.
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page 25
----------------------------------------------------------------------------
The field may be from 1 to 31 characters long.
Last Date Played
----------------
This field shows the last date on which the player in
question entered the game. The field is an 11 character
alpha numeric field and is expressed as MMM DD YYYY. The
MMM portion is a 3 character alpha abreviation for the month.
The DD portion is the date of the month with a leading blank
or 0 as required. The YYYY field is the actual Gregorian
year. The field may be changed as desired. Setting it to an
old date will cause a player to be deleted if that player
does not call in before maintenance is run.
This field is updated every time the player enters the game
upon his exit of the program.
Total Time Played
-----------------
This field shows the number of minutes the player in question
has been in the game during the date shown in the last date
played field. You may want to reset this field, if you are
using the Timegen facility, to allow a player more time
within the program.
This field is a numeric field showing the amount of time
used that date. The field is reset to 0 when a player enters
the game the first time each day. It is updated everytime a
player exits the game.
As of this writing, this field is corrupted when a player
enters the game in local mode. Setting this field back to 0
will correct the problem.
Total Game Entries
------------------
This field shows the number of game entries of the player in
question on the last date played. This field is in the range
of 0 to 32000. The field is set to 0 upon a players first
entry into the game on each new day. The field is incremen-
ted automatically each time the players exits the game.
Language Setting
----------------
This field shows the player in questions language choice.
The field is a 3 character alpha-numeric field which repre-
sents the file extention of the message files used in the
game. This field may be set to any alpha numeric string that
matches one of the language file extentions supported by the
program. The language extentions will depend on which lan-
guages are available and which language extentions you have
aquired.
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page 26
----------------------------------------------------------------------------
The field is set either automatically or by player choice
when he first enters the game. It may be changed by the
player, if the multi-lingual option is enabled, anytime the
player is in the game. Setting this field to an extention
that you don'y have will cause an error when the player
enters the game and will thus prevent him/her from playing.
Graphics Setting
----------------
This field shows the player in questions graphics setting.
The field is set to either ASCII, IBM, or COLOR to represent
the graphics setting the player has selected. This field may
be toggled to any of these three values. This field is
originally set by the player when he first enters the game.
It may be changed by the player at anytime the player is in
the game and selects the appropriate command.
Message Delay Setting
---------------------
This field shows the player in question's message delay
factor. The field is set automatically to MODERATE upon a
players original entry into the game. The player may then
update the field whenever he/she is in the game. The field
may be toggled to any of its settings.
Current Games Total
-------------------
This field contains the total number of games the player has
completed since the last time the game ratings were reset.
The field is incremented each time the player wins a game.
It is used to calculate the players current rating at the
end of each game.
This field is a numeric field and may be set to any number
0 or larger. The field is automatically reset to 0 whenever
the game ratings are reset.
Current Score Total
-------------------
This field contains the total number of points a player has
accumulated since the last time the player ratings were
reset. The field is updated ecery time the player completes
a game and is used to calculate the player rating.
This field may be set to any number greater than or equal
to 0. It is automatically reset to 0 whenever tha player
ratings are reset.
Current Rating
--------------
This field contains the players current rating. It reflects
his/her current score total divided by his/her current games
total. The field is set each time the player completes a
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page 27
----------------------------------------------------------------------------
game. Changing this field will have no effect since it is
set each time before it is used.
The field may contain any number greater than or equal to
0.
All Time Games Total
--------------------
This field contains the total number of games the player has
completed since the first time he/she played. It is used to
derive his all time rating. The field is initally set to 0
and is incremented by 1 each time the player completes a
game.
This field is a numeric field and may be set to any number
0 or larger.
All Time Score Total
--------------------
This field contains the total number of points a player has
accumulated since he/she first played. The field is initia-
lized to 0 and then updated each time the player completes a
game. It is used to calculate the player all time rating.
This field may be set to any number greater than or equal
to 0.
All Time High Rating
--------------------
This field contains the players best rating since he/she
started playing the game. It is updated at the end of each
game if the players new current rating is higher than this
field.
This numeric field can be set to any number greater than or
equal to 0.
Edit Current High Scores
------------------------
This menu entry takes you to a sub menu that shows the
player's current high scores, and the date they earned the
score, for each of the 25 game scenarios. The high scores
are reset each time the reset high scores maintenance func-
tion is run.
The score fields may be any number 0 or larger. The date
fields are in standard MMM DD YYYY format.
Edit All Time High Scores
-------------------------
This menu entry takes you to a sub menu that shows the
player's all time high scores, and the date they earned the
score, for each of the 25 game scenarios. The high scores
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page 28
----------------------------------------------------------------------------
are initially set to 0 the first time a player enters the
game. They are updated each time the player completes a
game and has achieved a higher score than the current value.
The score fields may be any number 0 or larger. The date
fields are in standard MMM DD YYYY format.
Save Player
-----------
This menu entry will write the current player record back
to the player file and thus make the changes permanent. As
a safety guard, you will be prompted if you attempt to
change player record or exit the player editor without
first writing the record back to the player file.
Exit Player Editor
------------------
This menu entry will ext the player editor and return back
to the main editor menu. As mentioned above, you will be
prompted if you attempt to exit the editor and have not
saved your changes to the current player record.
6.2 Ratings Editor
==================
The ratings editor is used to change the master ratings record.
The master rating record is used to generate the top 10 rated
players bulletin. The record is completely reset each time a
ratings reset is executed.
Editing Player Ratings
----------------------
The top 10 players are listed with either their name or
their alias, their ship's name, their rating, the total
current games played, and the date they last completed a
game. When you select an entry, you will be prompted
for each of these items. The entire list is cleared
whenever you execute a player ratings reset.
The name and ship name fields may each be from 1 to 31
characters. The rating and total games fields may be
set to any positive number. The date field is in standard
MMM DD YYYY format.
Changing Last Reset Date
------------------------
The last reset date field contains the date when a reset
player ratings command was executed. Changing this field
to a date prior to the current setting will speed up the
next reset if you have automatic maintenance enabled and
the configuration command RESETR: is non zero. Setting
the date to a date beyond the current date will produce
unpredictable results.
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page 29
----------------------------------------------------------------------------
This field is stored in standard MMM DD YYYY format.
Saving Rating Information
-------------------------
Selecting the 'save and exit' menu entry will write the
master ratings record back to the ratings file and return
back to the main editor menu.
Discarding Rating Information
-----------------------------
Selecting the 'discard and exit' menu entry will discard
the changes you have made, and return back to the main
editor menu.
6.3 High Scores Editor
----------------------
The high scores editor will allow you to examine and modify
the top two players for each of the 25 game scenarios. All
of the high score information is cleared whenever you execute
a reset high scores function.
1st and 2nd Place Player Information
------------------------------------
For each of the 25 game scenarios, the information on
the two players who hold the highest scores will be shown.
The 1st place player information will be displayed on the
left side of the screen while the 2nd place player informa-
tion will be displayed on the right side of the screen.
Players Name/Alias
------------------
This field will show the players name or alias (depending
on the setting of the configuration file command ALIAS:).
Changing this field will not effect the game itself, but
will change the results in the Game High Scores bulletins.
This field may contain from 0 to 31 characters.
Players Ship Name
-----------------
This field contains the name of the associated players
ship as shown in the Game High Scores bulletins (It does
not change the name of the players ship).
This field may contain from 0 to 31 characters.
Players Score
-------------
This field shows the high score achieved by the associated
player for the game in question. Changing it will effect
the Game High Scores bulletins the next time they are
generated.
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page 30
----------------------------------------------------------------------------
This field may contain any positive number.
Date Game Was Played
--------------------
This field shows the date the game played by the associated
player was completed. Changing this field will have no
effect on the game. It may however show in the bulletins
the next time bulletins are generated.
This field is in standard MMM DD YYYY format.
Changing Last Reset Date
------------------------
The last reset date field contains the date when a reset
game high scores command was executed. Changing this field
to a date prior to the current setting will speed up the
next reset if you have automatic maintenance enabled and
the configuration command RESETS: is non zero. Setting
the date to a date beyond the current date will produce
unpredictable results.
This field is in standard MMM DD YYYY format.
Previous Game Information
-------------------------
Selecting this menu item will change the editor from the
current game record to the previous game record. If you
have modified the current record, you will be prompted before
the change is made.
Next Game Information
---------------------
Selecting this menu item will change the editor from the
current game record to the next game record. If you have
modified the current record, you will be prompted before
the change is made.
Saving High Scores
------------------
Selecting this menu item will cause all changes made to the
current high scores record to be written back to the ratings
file. As a safetyguard, if you attempt to change game score
records or exit the high scores editor, you will be prompted
to guarantee that you don't accidentally lose your updated
information.
Exiting High Scores Editor
--------------------------
Selecting this menu item will exit the high scores editor
and return you to the main editor menu. If you have made
changes to the current game high scores and have not saved
them, you will be prompted to make sure you want to exit.
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page 31
----------------------------------------------------------------------------
6.4 Games in Progress Editor
----------------------------
This editor will allow you to view and modify all aspects of a
game in progress. The editor was primarily designed as a debug
tool, so for the most part you will not need to use it. In the
event you do use it, all of the game fields are described below:
Changing Games
--------------
Near the top of the screen you will find the current game
record number as well as the total number of game records.
Use the PgUp and PgDn keys (with NumLock set) to switch to
the previous or next game record. If you have modified the
current game record, you will be prompted to make sure you
want to switch records and discard the changes before the
record is changed.
Game Number
-----------
This field indicates the game scenario that is being played.
Scenarios 1 through 5 are built into the program, while sce-
narios 6 through 25 are supported as external scenarios (see
chapter 7). Changing this field will have disasterous effects
as it may place ships or bases on land thus preventing the
ships from moving, and preventing ships from getting to the
bases. The field is set to 0 to release the game in progress
record for reuse.
If you disconnect a player from a game in the player editor,
then you should also clear the game record in this editor.
This will be done automatically in a future version.
The numeric field may contain any number between 0 and 25.
Game Turn
---------
This field contains the game turn. The field has no conse-
quence on the game except for marking the passage of time;
therefore changing this field will have no effect.
This numeric field may contain any positive number.
Game Score
----------
This field shows the number of points the player has scored
so far in the game. Changing the field will have the obvious
effect of changing his/her eventual game score.
This numeric field may contain any number greater than or
equal to 0.
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page 32
----------------------------------------------------------------------------
Sub Bases
---------
Selecting this menu entry will take you to the Sub Bases
sub-menu (no pun intended). In this menu, you will see the
positions of all of the sub bases. There may be from 1 to
32 active sub bases. The greater the number of bases, the
greater the randomness of where new subs will appear.
Each field contains the Y and X coordinates of the base.
The Y coordinate must be in the range of 1 to 17. The X
coordinate must be in the range of 1 to 49. If you move
or create bases, make sure you don't place them on land as
this will cripple the game. Any changes you make effect
this game only and not the scenario as a whole.
Destroyer Bases
---------------
Selecting this menu entry will take you to the Destroyer
Bases sub-menu. In this menu, you will see the positions of
all of the destroyer bases. There may be from 1 to 4 active
destroyer bases. The greater the number of bases, the easier
the game will be to play.
Each field contains the Y and X coordinates of the base.
The Y coordinate must be in the range of 1 to 17. The X
coordinate must be in the range of 1 to 49. If you move
or create bases, make sure you don't place them on land as
this will cripple the game. Any changes you make effect
this game only and not the scenario as a whole.
Transport Ports
---------------
Selecting this menu entry will take you to the Transport
Ports sub-menu. In this menu, you will see the positions of
all of the transport ports. There may be from 1 to 4 active
transport ports. The greater the number of ports, the easier
the game will be to play.
Each field contains the Y and X coordinates of the port.
The Y coordinate must be in the range of 1 to 17. The X
coordinate must be in the range of 1 to 49. If you move
or create ports, make sure you don't place them on land as
this will cripple the game. Any changes you make effect
this game only and not the scenario as a whole.
Sub Status
----------
This field shows the current status of the U-boat. After
a U-boat is destroyed, it is randomly set to one of the
destroyed status values. It must then progress through the
stages until it is once again deployed. At that time a
sub base will be chosen at random and the U-boat set to that
position.
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page 33
----------------------------------------------------------------------------
This field is a toggle field and may be toggled to any value.
Destroyer Fuel
--------------
This field shows the amount of fuel the destroyer has. The
destroyer starts off with 56 units of fuel and expends one
unit of fuel in each turn in which the destroyer moves. The
fuel is reset back to 56 whenever the detroyer enters a
destroyer base.
This numeric field may contain any number in the range of 0
through 56.
Destroyer Depth Charges
-----------------------
This field shows the number of depth charge sets the destro-
yer has remaining. The destroyer starts of with 11 sets of
charges, and expends one set for each depth charge attack.
The field is rest back to 11 whenever the destroyer enters
a destroyer base.
This numeric field may contain any number in the range of 0
through 11.
Transport Launch Period
-----------------------
This field shows the number of turns that must pass between
the time a transport is ready to be launched and when it is
launched. The field is set to 3 after each transport launch.
This numeric field may contain any number in the range of 1
through 3.
Unlaunched Transports
---------------------
This field shows the number of transports that are still
waiting to be launched. Changing this field will obviously
either shorten or lengthen the game. Each game scenario
starts with 16 unlaunched transports.
This numeric field may contain any number in the range of
0 through 16.
Transports At Sea
-----------------
Selecting this menu entry will take you to the Transports
At Sea sub menu. The menu will shown the locations of all
transports currently at see. There may be up to 4 transports
at sea at any one time. Be extremely careful if you move
or create a transport at sea that you do not move it to
a location surrounded by land or the transport will never
move and the game will therefore never end.
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page 34
----------------------------------------------------------------------------
Each transports location is show as it's Y and X coordinates.
The Y coordinates must be in the range of 1 to 17 and the X
coordinates must be in the range of 1 to 49.
Transport Missions Completed
----------------------------
This field shows the number of successful transport missions
thus far in the game scenario. This field is initially set
to 0 and is then incremented by 1 each time a transport arri-
ves safely at a port. At the end of the game, this field is
tested to see if all missions were successful and if so, the
safe transport bonus is granted to the user. Changing this
field will have the obvious effect of lessening or increa-
sing the players chance to get the bonus.
This numeric field may contain any number in the range of 0
through 16.
Transport Completion Points
---------------------------
This field shows the amount of points that will be awarded
for the next transport that successfully arrives at a port.
The field is initially set to 250 and is incremented by 50
each time a transport arrives in port. Changing this field
will have the obvious effect of changing the players final
score.
This numeric field may be set to any multiple of 50.
Saving Game Information
-----------------------
Selecting this menu entry will cause all current changes to
be written back to the game in progress record. As a safety
precaution, attempting to change the current game record or
to exit the game in progress editor without first saving the
game information will cause a prompt to be displayed asking
if you are sure you want to discard the information.
Exiting Game Editor
-------------------
Selecting this menu entry will exit the games in progress
editor and return to the main editor menu. In the event
that current game information has been changed but not saved,
a prompt will be displayed asking if you are sure you want
to discard the information.
6.5 Resetting High Scores
-------------------------
This feature will allow you to reset all current high scores.
The configuration file command 'RESETS:' will be ignored, and
all current high scores will be immediately reset and the
bulletins rebuilt.
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page 35
----------------------------------------------------------------------------
6.6 Resetting Player Ratings
----------------------------
This feature will enable you to reset all of the current player
ratings. The configuration file command 'RESETR:' will be
ignored, and all of the current player ratings will be immediatly
cleared, and the bulletins will be rebuilt.
6.7 Resetting Full Game
-----------------------
This feature is a combination of the above two features.
6.8 Purging Old Users
---------------------
This feature will cause the player file to be scanned and all
users who have not entered the game for more days than that
specified by the configuration file command 'PURGE:' will be
freed.
6.9 Reviewing Program Error Log
-------------------------------
This feature will allow you to review the program error log.
under normal circumstances you should not have anything in the
error log other than the warning that it is creating the games
in progress error. If you do encounter other errors that you
cannot understand or feel should not have occured, please con-
tact the Mycroft Systems voice help line.
After you have reviewed the error log, you will be prompted to
see if you want to delete it.
6.10 Exiting the Editor
-----------------------
This feature is used to exit the editor. If the editor was
directly entered then you will be returned to DOS or the BBS
depending on how you entered. Otherwise you will be returned
to the U-Boat Main Menu.
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page 36
----------------------------------------------------------------------------
NOTE: THESE CHAPTER ONLY APPLY TO THE REGISTERED VERSION OF U-BOAT!
7.0 Creating Additional Game Scenarios
======================================
The registered version of U-Boat will support 20 additional game
scenarios. These scenarios are defined as external files named
UBOAT-nn.MAP where the nn represents a number between 06 and 25.
Each scenario has a fixed format and is described below.
7.1 Maximum Scenario Support
----------------------------
As mentioned above, the shareware version of the software sup-
ports 5 built-in game scenarios. The registered version supports
the same 5 built in screnarios plus up to 20 external scenarios.
7.2 Map File Format
-------------------
The first line of the map file is used to contain the scenario
title. The title is limited to a maximum of 16 characters.
The remainder of the file consists of 19 lines of 51 characters
which are used to define the game scenario map. The first and
last lines and the first and last columns must be defined as
land. The remainder of the map may be setup in any arrangement
provided you do not build routes that may trap the transports.
Transports may only move north, south, or east (with the excep-
tion of sea lanes (see below)), so you you must take care NOT
to generate a route that they cannot escape from. A sample
external scenario is provided in the file UBOAT-06.MAP.
The following sections describe the various items that may be
used to build a map:
[ ] Seas
--------
Seas are the normal terrain of the game. All types of ships
may maneuver through sea locations.
[#] Land
--------
Land locations are off limit to all types of ships. Use the
land locations to generate a variety of islands and peninsu-
las to provide the transports a variety of routes to follow
to their target port(s). As mentioned above, it is required
that the 1st and last lines and 1st and last columns of the
map be land locations. These locations are not displayed to
the user and are just to support the movement logic in the
game to prevent ships from sailing off the edge of the map.
[C] Transport Base
------------------
There may only be 1 transport base. The transport base is
the location that all transports will be launched from. It
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page 37
----------------------------------------------------------------------------
is off limits for all ship types to enter the transport base.
The base should be located on the western edge of the map
since the transports move primarily eastward. The base
should not be located too close to any sub bases.
[T] Transport Ports
-------------------
You may define up to 4 transport ports. These are the tar-
get locations that the transports must reach to complete
their journeys. Transport ports may only be entered by
transports. These ports should be located at the eastern
edge of the map (for reasons explained above). They should
not be placed too close to a sub base.
[D] Destroyer Bases
-------------------
You may define up to 4 destroyer bases. These can be placed
anywhere on the map. Their number and locations will greatly
effect the difficulty of the scenario. Destroyer bases may
only be entered by destroyers.
[S] U-Boat Bases
----------------
U-Boat bases, also refered to as sub bases may be placed in
any location on the map. There must be at least one base
and there is a maximum of 32. It is suggested that these
bases be located along the northern and southern edges of
the map. It is also recommended that the bases be spread
out to provide a good random U-boat deployment. Also, do
not locate sub bases too close to the tarnsport base or the
transport ports. Sub bases are not displayed on the map
and are thus invisible to the player. Sub bases may be en-
tered by all ship types.
[nsew] Sea Lanes
----------------
Sea lanes are one of the most important features in U-Boat.
If left alone to move about completely at random, the trans-
ports would take forever to reach their destinations and may
also get 'clogged up' together in certain areas making them
easy prey as a group for U-boats. When a transport starts
it's turn in a sea lane location, it will automatically
move the direction indicated by the sea lane (n=north,
s=south, e=east, and w=west). It is important to use sea
lanes around the transport base so that the transports don't
get all 'clogged up' when starting, around transport ports
to guide them in as quickly and as efficiently as possible,
and in areas of the map where they are likely to get stuck.
Overuse of sea lanes can be equally disasterous by making the
scenario too easy.
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page 38
----------------------------------------------------------------------------
8.0 Notes from the Author
=========================
As many of you know, Mycroft Systems has produced quite a string of
door games and utilities. We strive to produce quality programs and
to support them as best we can.
U-Boat is meant to follow in that tradition. Using a new message
control system, U-Boat is on of our first doors designed to support
a multitude of human languages. This feature will hopefully be
reproduced in all future doors and be slowly retro-fitted into our
existing doors.
We have also, as with a few of our previous doors, attempted to make
the documentation available from within the program. With U-Boat we
are taking the further step of adding a complete online help system.
This we also hope to provide in our future offerings.
As with following our policies, U-Boat is designed to be an enjoya-
ble program with an attractive user interface that is easy to run
and install. If we have failed in any way, we would love to here
from you in the form of either letters or comments.
Michael W. Bayley
Mycroft Systems
P.O Box 7672
San Jose, CA. 95150
BBS: (408)927-0105
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page A.1
----------------------------------------------------------------------------
A.0 Registration Information
============================
You are encouraged to register your copy of U-Boat. Upon doing so
you will be mailed the latest version of the program. The version that
you receive will be the commercial version with the editors enabled and
all of the other restrictions removed.
To register, please fill out the order form in the file ORDER.TXT in
the docs subdirectory. You can register this door only or you can
take advantage of one of our package deals which provide substantial
discounts.
The registration fee for U-Boat is $10 US plus tax in applicable loca-
tions. Also a $2 shipping and handling fee must be included to cover
our costs for diskettes, mailers, and postage. Your order will be
promptly processed.
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page B.1
----------------------------------------------------------------------------
B.0 List of Files
=================
U-Boat files fall into 4 types. These file types are assigned to
various subdirectories. Each type of file is described here in
detail.
B.1 Documentation Files
-----------------------
The documentation files are those files to support the SysOp in
setting up and maintaining the program. Once printed, these may
be copied off to floppy or simply deleted. Please review each of
these files.
UBTSYSOP.DOC - SysOp Documentation
----------------------------------
This is the SysOp documentation file you are currently reading.
This file contains all information for the installation, the
initialization, and the maintenance of the game. Detailed
information is provided for all configurations, generation of
new scenarios, editor usage, etc..
UBOAT.DOC - User Documentation
------------------------------
This file is the user documentation file. It is avalable to
users to download in the documentation menu. Encourage your
users to download and read this file as it will make the game
more enjoyable as opposed to constantly seeking online help.
UBOAT.ZIP - User Documentation (Compressed)
-------------------------------------------
This file is the compressed version of the user documentation
file above. It is also availble through the documentation
menu. If you prefer to user a different form of compression,
see the section on the configuration file command 'EXT2:'.
UBOAT-HP.PCL - User Documentation (PCL-4)
-----------------------------------------
This file is the documentation in HP Laserjet + compatible
format (PCL-4).
NOTE: THIS FILE IS NOT YET AVAILABLE.
UBOAT-HP.ZIP - User Documentation (PCL-4, Compressed)
-----------------------------------------------------
This file is the documentation in HP Laserjet + compatible
format (PCL-4) and that has been compressed. See the
section on configuration file command 'EXT4:' if you wish to
use a different compression format.
NOTE: THIS FILE IS NOT YET AVAILABLE.
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page B.2
----------------------------------------------------------------------------
UBOAT.CFG - Sample Configuration
--------------------------------
This file is a sample UBOAT.CFG file. It is setup to con-
tain all of the commands with their default values.
REGISTER.TXT - Registration Information
---------------------------------------
This file contains information on registering your copy of
U-Boat. We encourage all SysOps who run the game to regis-
ter their copies. It is suggested however that you use
the ORDER.TXT file to order your registered copy.
DOORS.TXT - Mycroft Door Descriptions
-------------------------------------
This file contains information on other door programs available
form Mycroft Systems. Review this document at your leisure
to see if you would be interested in any other of our door
programs.
ORDER.TXT - Mycroft Door Order Form
-----------------------------------
This file is the Mycroft Doors-by-Mail order form. Fill it
and and send it to any Mycroft Dealer to get the most recent
registered version sent to you by mail. Please check the
"date valid through" line to check if pricing information is
still valid. If the pricing information is out of date, you
can get an up-to-date price list by calling any Mycroft
Dealer.
DISTRIB.TXT - Mycroft Distributors List
---------------------------------------
This file is a current list of Mycroft Distributors. Please
note that Distributors are not Dealers. Don not send orders
to them. The Distributor List shows a complete list of BBSs
you may call to check on and download recent versions of
Mycroft Doors. We hope there is one in your dialing area. If
not, consider becomming a Mycroft Distributor yourself.
B.2 Message Files
-----------------
The message files are those files containing text information that
a user will see or read within the game. These files are located
in the MSGS subdirectory. This section will describe the standard
files shipped with the program. These are the US (English) message
bases. Other languages will have the same support files with a
different file extention. See the section on multi-lingual support
for more information.
UBOAT_S.ENG - Signon Screens
----------------------------
This file contains all the screens used at game entry. All of
the animation screens are in this file.
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page B.3
----------------------------------------------------------------------------
UBOAT_M.ENG - Menus & Game Text
-------------------------------
This file contains most of the menus, the display screens, and
the messages used in U-Boat.
UBOAT_H.ENG - Help Text
-----------------------
This file contains all of the help screens, menus, and text
required to support the online help system built into the
game.
UBOAT_R.ENG - Error Text
------------------------
This file contains all of the error messages the program is
capable of generating.
UBOAT_E.ENG - Editor Text
-------------------------
This file is the editor message file used in the various edi-
tors. It contains all of the menus, display screens, prompts,
and other text used in the editor.
UBOAT_X.ENG - Editor Help Text
-------------------------------
This file contains all of the help screens, menus, and text
required to support online help for the editor.
B.3 Program Files
-----------------
The program files reside in the main program directory. They are
used to run and configure the program as well as support some of
the programs functions. Here is a description of the program
files.
UBOAT.BAT - Sample Batch File
-----------------------------
This file is a sample batch file that may be used or modified
to invoke U-Boat. If you are using the INSTALL.EXE program,
a custom batch file will automatically be generated for you.
UBTXFER.BAT - Sample Download Batch File
----------------------------------------
This file is a sample of the support file used to enable the
downloading of documentation from within the program.
UBOAT.EXE - Program Executable File
-----------------------------------
This file is the program executable file. It consists of a
main body plus several overlays, which are built in, to run
the various sections of the program.
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page B.4
----------------------------------------------------------------------------
UBOAT.CFG - Program Configuration File
--------------------------------------
This file is the game configuration file. It is a standard
ASCII text file and mau be modified using a standard editor.
See the section on game configuration for details of this
file. If you use the INSTALL.EXE program provided with this
door, then this file will automatically be built for you.
UBOAT.LNG - Language Selection File
-----------------------------------
This file is the language configuration file. It is optional
and only used when you are configuring your version as a
multi-lingual version. The file is a standard ASCII text
file and can be modified with a standard text editor. See the
section on Multi-Lingual Support for more information.
UBOAT.ERR - Error Tracking File
-------------------------------
This file is the error tracking file. Almost any error in
the program will generate a message to this file. The error
will be recorded in the language selected in the configuration
file. If the configuration file has not been read or if the
message file containing the error cannot be found then the
error will be recorded as:
Date: MMM DD YYYY User: <user login>
Error [ErrorTag] -
Under normal circumstances, the error tag will be followed by
text from the message file.
UBTAUTH.MSG - Author Message File
---------------------------------
This file contains a message from the author to the players.
It will usually contain information concerning new changes to
the program. Whenever you install an updated version of
U-Boat, you should run the utility FLAGMSG against this file
to guarantee all users will see this message. The file is a
standard ASCII text file.
UBTSYSOP.MSG - SysOp Message File
---------------------------------
This file contains a message from the SysOp to the players.
It should be used to pass information to your players. It
can be used in circumstances like your having changed the
game configuration via the editor. The file is a standard
ASCII text file and can be modified using a standard text
editor. Each line of the file is limited to 78 characters.
TIMEGEN.EXE - Timegen Utility
-----------------------------
This file is the Timegen Utility executable file. This program
is used to impose limits on game access based by user security
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page B.5
----------------------------------------------------------------------------
levels, time of day, and total time each day. See the
installation section for more information.
TIMES.DEF - Sample Time Control File
------------------------------------
This file is a sample time control source file. The time
control source file is compiled using Timegen to generate the
time control file used by the game.
UBOAT.TIM - Game Time Control File
----------------------------------
This file is a time control file for U-Boat. The file is
completely optional and only need be used if you want to
restrict access to the program. See the chapter on
installation for more information.
NODES.BBS - Node Definition File Sample
---------------------------------------
This is a sample node ID file. This file must be in the BBS
directory for the program to run remotely. If you use the
INSTALL.EXE program, the file will automatically be built for
you. The file is a standard ASCII text file and is described
in detail in the chapter on installation.
PORTS.BBS - Port Definition File Sample
---------------------------------------
This is a sample communications port ID file. This file, if
used, must be in the BBS directory for the program to run
remotely. If you use the Install Programs, the file will
automatically be built for you. The file is a standard ASCII
text file and is described in detail in the chapter on
installation.
B.4 Data Files
--------------
The Data Files in U-Boat reside, for the most part, in the main
program directory. The files that end in .DAT are the data
files used by the game.
UBT-RATE.DAT - Player Ratings Data
----------------------------------
This file is the player ratings file. Records are kept for
the highest ratings as well as records for the highest scores
for each game. It's contents may be viewed by using the
player ratings editor and the game high scores editor.
UBT-GAME.DAT - Games in Progress Data
-------------------------------------
This file is records for each of the games currently in pro-
gress. The records are automatically reused as games are
completed and their records are freed. You can view the
contents of this file by using the games in progress editor.
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page B.6
----------------------------------------------------------------------------
UBT-PLYR.DAT - Player Data
--------------------------
This file is the player file. Records are kept for each user
who has entered the game. User records that are freed due
to a player being purged are automatically reused. The
contents of this file may be viewed by using the player edi-
tor.
<bullet1> - Player Ratings Bulletin (B/W)
-----------------------------------------
The player ratings bulletin will display the top 10 rated
players in the game. To qualify as a rated player, the
player must complete the first five scenarios at least once.
The filename and path for the bulletin are defined by the
configuration file command 'BULL:'.
<bullet2> - Player Ratings Bulletin (Color)
-------------------------------------------
This bulletin is identical to bulletin 1 except that it is
in color. The filename and path for the bulletin are defi-
ned by the configuration file command 'BULLC:'.
<bullet3> - Game High Scores Bulletin (B/W)
-------------------------------------------
The game high scores bulletin will display the top 2 scores
acheived for each of the game scenarios. The filename and
path are defined by the configuration file command 'BULL2:'.
<bullet4> - Game High Scores Bulletin (Color)
---------------------------------------------
This bulletin is identical to bulletin 3 except that it is
in color. The filename and path for the bulletin are defi-
ned by the configuration file command 'BULLC2:'.
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page C.1
----------------------------------------------------------------------------
C.0 SysOp Function Keys
=======================
This appendix will describe the various keys available to SysOps while
a user is within the program.
[Alt F10] This key will eject the current user from the game by
setting all his door access time to consumed.
[Rgt Arrow] This key will add 1 minute of door access time to the
current users current door session.
[Lft Arrow] This key will subtract 1 minute of door access time
from the current users current door session.
[F1] The F1 key will toggle between the various help status
lines. These lines will list all of the other SysOp
keys.
[F2] The F2 key will temporarily turn off the snoop toggle.
It will then display information about the user, such
as when he/she logged into the game, when he/she will
run out of time, his password, etc. To exit the user
information display, press the [END] key.
[F3] The F3 key will temporarily turn off the snoop toggle.
It will then display information about the player,
such as his/her alias, his/her rating, etc.. To exit will
the player information display, press the [END] key.
[F4] The F4 key will temporarily turn off the snoop toggle.
It will then display information about the game in
progress, such as turn number, transport score, game
scenario name, remaining number of transports, etc..
The game information display is only available when
the player is actively playing a scenario. To exit
the game information display, press the [END] key.
[F5] The F5 key will toggle the users access to the pro-
gram editors. The status line will show an '*'
towards the right side when the user has access.
[F8] The F8 key will toggle the state of the SysOp snoop
toggle. Note that it is reset to its original state
when the BBS is reentered. When this toggle is true,
the local screen will display the same information
as the remote screen. When the toggle is false, the
local screen will remain blank display a single status
line that will be moved aproximately every 5 seconds.
[F9] The F9 key will allow you to drop to a DOS shell. The
player is notified that you have done so, and is locked
out until you return. It is important that you remem-
ber to return to the main U-Boat directory before ty-
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page C.2
----------------------------------------------------------------------------
ping 'EXIT' to exit the DOS shell back to the game.
[F10] The F10 key is used to initiate CHAT mode. This allow
the SysOp to converse with the user via the keyboard
The CHAT in this program supports both automatic word
wrap, and also two tone chat mode. Use the [ESC] key
to terminate chat mode.
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page D.1
----------------------------------------------------------------------------
D.0 Command Line Options
========================
This section covers the various command lines supported by U-Boat.
The first group of command lines will run with either the shareware
or the registered version.
UBOAT Execute the program in local mode.
The User is prompted for login and
password. No time controls apply
except the keyboard timeout.
UBOAT node Execute the program in G-Mon mode.
G-Mon support files are scanned for
user information. "node" represents
the BBS node number.
UBOAT node path tag Standard command line. Executes
U-Boat in remote BBS mode. The 'node'
parameter is the BBS node number,
the 'path' parameter is the path to
the BBS files, and 'tag' is the BBS
tag ID. The BBS interface files are
scanned for the user info.
UBOAT MAINTENANCE Execute U-Boat program maintenance.
This should be run once each every
week or so.
The following command lines work only with the registered version of
U-Boat.
UBOAT EDITOR Run the editor in local mode. Login
and password are still required.
UBOAT node path tag EDITOR Run the editor in remote mode. The
parameters are the same as running the
game in remote BBS mode. The login
name is tested against allowed editor
users, and a password is required.
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105
U-Boat SysOps Documentation - Version 1.00 Page E.1
----------------------------------------------------------------------------
E.0 Multi-Lingual Support
=========================
U-Boat is one of the first Mycroft Door designed to support multiple
human languages. Language support is possible due to an inovative
external message file system. As time goes by, more and more Mycroft
Doors will be converted to the multi-lingual support system. Also
more and more languages will be supported.
In U-Boat, adding another language is as simple as 1, 2, 3. 1. Iden-
tify the language you want to add; 2. Download the language support
file (for U-Boat, these will be available as UBT-xxx.ZIP where the
xxx in the language extention) and unzip it into the MSG subdirectory;
3. Add a line to the language control file (for U-Boat this is
UBOAT.LNG).
The following languages are proposed to be supported at some point.
ENG - English code page 437 UKG - English code page 850
FRN - French code page 437 FRC - French code page 863
SPN - Spanish code page 437 SPS - Spanish code page 850
GRM - German code page 437 GMN - German code page 850
ITL - Italian code page 437 ITN - Italian code page 850
PTG - Portugese code page 437 PTU - Portugese code page 860
If you are interested in doing a language conversion, please
contact the author.
To make the languages available to your users, you will need to
create a language control file named UBOAT.LNG. This file consists
of 2 or more language definition records. Each record is a single
line. The first part is a 3 character file extention, and the
second part is the language definition text to be displayed in the
language selection menu. The following is a sample to offer English,
French, and German:
ENG English
FRN Francais
GRM Deutch
We hope the multi-lingual support feature becomes a popular one and
that many SysOps will volunteer to do language conversions.
----------------------------------------------------------------------------
Mycroft Systems, P.O. Box 7672, San Jose, CA. 95150 BBS: (408)927-0105